home *** CD-ROM | disk | FTP | other *** search
/ Mac Easy 2010 May / Mac Life Ubuntu.iso / casper / filesystem.squashfs / usr / lib / perl5 / Glib / Flags.pod < prev    next >
Encoding:
Text File  |  2008-11-04  |  2.4 KB  |  209 lines

  1. =head1 NAME
  2.  
  3. Glib::Flags -  Overloaded operators representing GLib flags
  4.  
  5. =head1 HIERARCHY
  6.  
  7.   Glib::Flags
  8.  
  9. =for object Glib::Flags Overloaded operators representing GLib flags
  10.  
  11. =for position DESCRIPTION
  12.  
  13. =head1 DESCRIPTION
  14.  
  15. Glib maps flag and enum values to the nicknames strings provided by the
  16. underlying C libraries.  Representing flags this way in Perl is an interesting
  17. problem, which Glib solves by using some cool overloaded operators. 
  18.  
  19. The functions described here actually do the work of those overloaded
  20. operators.  See the description of the flags operators in the "This Is
  21. Now That" section of L<Glib> for more info.
  22.  
  23. =cut
  24.  
  25.  
  26.  
  27.  
  28. =head1 METHODS
  29.  
  30. =head2 scalar = $class-E<gt>B<new> ($a)
  31.  
  32. =over
  33.  
  34. =over
  35.  
  36. =item * $a (scalar) 
  37.  
  38. =back
  39.  
  40. Create a new flags object with given bits.  This is for use from a
  41. subclass, it's not possible to create a C<Glib::Flags> object as such.
  42. For example,
  43.  
  44.     my $f1 = Glib::ParamFlags->new ('readable');
  45.     my $f2 = Glib::ParamFlags->new (['readable','writable']);
  46.  
  47. An object like this can then be used with the overloaded operators.
  48.  
  49. =back
  50.  
  51. =head2 scalar = $a-E<gt>B<all> ($b, $swap)
  52.  
  53. =over
  54.  
  55. =over
  56.  
  57. =item * $b (scalar) 
  58.  
  59. =item * $swap (integer) 
  60.  
  61. =back
  62.  
  63. =back
  64.  
  65. =head2 scalar = $a-E<gt>B<as_arrayref> ($b, $swap)
  66.  
  67. =over
  68.  
  69. =over
  70.  
  71. =item * $b (scalar) 
  72.  
  73. =item * $swap (integer) 
  74.  
  75. =back
  76.  
  77.  
  78.  
  79. =back
  80.  
  81. =head2 integer = $a-E<gt>B<bool> ($b, $swap)
  82.  
  83. =over
  84.  
  85. =over
  86.  
  87. =item * $b (scalar) 
  88.  
  89. =item * $swap (integer) 
  90.  
  91. =back
  92.  
  93.  
  94.  
  95. =back
  96.  
  97. =head2 integer = $a-E<gt>B<eq> ($b, $swap)
  98.  
  99. =over
  100.  
  101. =over
  102.  
  103. =item * $b (scalar) 
  104.  
  105. =item * $swap (integer) 
  106.  
  107. =back
  108.  
  109. =back
  110.  
  111. =head2 integer = $a-E<gt>B<ge> ($b, $swap)
  112.  
  113. =over
  114.  
  115. =over
  116.  
  117. =item * $b (scalar) 
  118.  
  119. =item * $swap (integer) 
  120.  
  121. =back
  122.  
  123. =back
  124.  
  125. =head2 scalar = $a-E<gt>B<intersect> ($b, $swap)
  126.  
  127. =over
  128.  
  129. =over
  130.  
  131. =item * $b (scalar) 
  132.  
  133. =item * $swap (integer) 
  134.  
  135. =back
  136.  
  137. =back
  138.  
  139. =head2 integer = $a-E<gt>B<ne> ($b, $swap)
  140.  
  141. =over
  142.  
  143. =over
  144.  
  145. =item * $b (scalar) 
  146.  
  147. =item * $swap (integer) 
  148.  
  149. =back
  150.  
  151. =back
  152.  
  153. =head2 scalar = $a-E<gt>B<sub> ($b, $swap)
  154.  
  155. =over
  156.  
  157. =over
  158.  
  159. =item * $b (scalar) 
  160.  
  161. =item * $swap (integer) 
  162.  
  163. =back
  164.  
  165. =back
  166.  
  167. =head2 scalar = $a-E<gt>B<union> ($b, $swap)
  168.  
  169. =over
  170.  
  171. =over
  172.  
  173. =item * $b (scalar) 
  174.  
  175. =item * $swap (integer) 
  176.  
  177. =back
  178.  
  179. =back
  180.  
  181. =head2 scalar = $a-E<gt>B<xor> ($b, $swap)
  182.  
  183. =over
  184.  
  185. =over
  186.  
  187. =item * $b (scalar) 
  188.  
  189. =item * $swap (integer) 
  190.  
  191. =back
  192.  
  193. =back
  194.  
  195.  
  196. =head1 SEE ALSO
  197.  
  198. L<Glib>
  199.  
  200. =head1 COPYRIGHT
  201.  
  202. Copyright (C) 2003-2008 by the gtk2-perl team.
  203.  
  204. This software is licensed under the LGPL.  See L<Glib> for a full notice.
  205.  
  206.  
  207. =cut
  208.  
  209.